home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / addpcb20.zip / ADDPCB.DOC next >
Text File  |  1992-12-01  |  22KB  |  592 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.         ███████┐ ████████┐ ████████┐ ███████┐ ███████┐ ████████┐
  8.         ██┌──██│ └██┌──██│ └██┌──██│ ██┌──██│ ██┌────┘ └██┌──██│
  9.         ███████│  ██│  ██│  ██│  ██│ ███████│ ██│       ███████│
  10.         ██┌──██│  ██│  ██│  ██│  ██│ ██┌────┘ ██│       ██┌──██│
  11.         ██│  ██│ ████████│ ████████│ ██│      ███████┐ ████████│
  12.         └─┘  └─┘ └───────┘ └───────┘ └─┘      └──────┘ └───────┘
  13.  
  14.  
  15.  
  16.  
  17.                  ADDPCB Version 2.0
  18.                  December 1, 1992
  19.  
  20.                  For PCBoard Systems
  21.  
  22.  
  23.          Copyright (C) 1992 by Bob Aune - All Rights Reserved.
  24.  
  25.  
  26.  
  27.  
  28.             Latest Versions and Support
  29.                  Available at the
  30.  
  31.                 OnLine Exchange BBS
  32.                   (714) 870-4614
  33.                2400-14,400 Baud V.32bis/HST
  34.  
  35.  
  36.  
  37.  
  38.      Are you tired of typing in the descriptions  every time  you add files
  39.      to your board?  With this program, typing in descriptions by hand will
  40.      be over.
  41.  
  42.      This time-saving program  aids the PCB Sysop by  importing files  with
  43.      their descriptions downloaded from other PCBoard BBS's to your PCBoard
  44.      BBS automatically.
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.                 Table of Contents
  57.                 ─────────────────
  58.  
  59.  
  60.        What is ADDPCB . . . . . . . . . . . . . . . . . . . . . . . . . 1
  61.  
  62.        Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
  63.  
  64.        Possible Uses  . . . . . . . . . . . . . . . . . . . . . . . . . 3
  65.  
  66.        Installation . . . . . . . . . . . . . . . . . . . . . . . . . . 4
  67.  
  68.        Starting ADDPCB  . . . . . . . . . . . . . . . . . . . . . . . . 4
  69.  
  70.        Command Line Options . . . . . . . . . . . . . . . . . . . . . . 5
  71.  
  72.        Operating ADDPCB . . . . . . . . . . . . . . . . . . . . . . . . 6
  73.  
  74.        Configuration (Fields) . . . . . . . . . . . . . . . . . . . . . 6
  75.  
  76.        Configuration (Options)  . . . . . . . . . . . . . . . . . . . . 7
  77.  
  78.        External Testing . . . . . . . . . . . . . . . . . . . . . . . . 8
  79.  
  80.        FILE_ID.DIZ Support  . . . . . . . . . . . . . . . . . . . . . . 8
  81.  
  82.        Support  . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
  83.  
  84.        Registration Information . . . . . . . . . . . . . . . . . . . .10
  85.  
  86.        Legal Stuff  . . . . . . . . . . . . . . . . . . . . . . . . . .11
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.      ADDPCB User Documentation                                       Page 1
  96.      ──────────────────────────────────────────────────────────────────────
  97.  
  98.  
  99.  
  100.      WHAT IS ADDPCB
  101.      ──────────────
  102.  
  103.      ADDPCB is a program that import files with  their descriptions to your
  104.      board painlessly. ADDPCB works off of 4 fields in the configuration as
  105.      shown on the main screen.  They are:
  106.  
  107.       / FILE                  - Containing descriptions       (field 1)
  108.      FROM
  109.       \ DIRECTORY             - Location of files to import   (field 2)
  110.  
  111.       / FILE                  - Descriptions get added to     (field 3)
  112.       TO
  113.       \ DIRECTORY             - Location to import files      (field 4)
  114.  
  115.      ADDPCB  looks for files  in the directory (field 2),  it might be your
  116.      download dir., misc. dir., or directory of  files  to be tested.  Next
  117.      it will search for the descriptions in a text file (field 1), The text
  118.      file could be a 'allfiles' list or a capture file.  If the description
  119.      is found, then the program will optionally test the file by calling an
  120.      external batch file and if the file passes the test, then will process
  121.      the description and the file into your system.
  122.  
  123.      This program can be run from a batch file or on the command line. It's
  124.      a ideal program to use after a download session  as it will import the
  125.      new files into your PCBoard system along with their descriptions.  The
  126.      automatic feature enables it to run in the unattended mode  such as in
  127.      events and with unattended communication programs.
  128.  
  129.  
  130.  
  131.      ADDPCB User Documentation                                       Page 2
  132.      ──────────────────────────────────────────────────────────────────────
  133.  
  134.  
  135.  
  136.      FEATURES
  137.      ────────
  138.  
  139.      -  Complete user interface with a built in configuration editor.
  140.  
  141.      -  Several configuration files can exist for importing files to
  142.     different conferences or directories.
  143.  
  144.      -  Can test whole directories of files without moving their location
  145.     or effecting the descriptions.
  146.  
  147.      -  Can be used in your event, comm program batch file, or on the
  148.     command line.
  149.  
  150.      -  Imports description from any ZIP archive containg FILE_ID.DIZ.
  151.  
  152.      -  Duplicate description and file detection with options.
  153.  
  154.      -  Optional test each file as it is imported to your board.
  155.  
  156.      -  Description Modification Options such as:
  157.     - First letter capitalized.
  158.     - All letters upper case.
  159.     - All letters lower case.
  160.     - Add 'Uploaded by (your name)' to the bottom of the description.
  161.  
  162.      -  Option to re-date the the file and the date in the description to
  163.     today's date.
  164.  
  165.      -  Can be used under a network or multitasker.
  166.  
  167.  
  168.  
  169.      ADDPCB User Documentation                                       Page 3
  170.      ──────────────────────────────────────────────────────────────────────
  171.  
  172.  
  173.  
  174.      POSSIBLE USES
  175.      ─────────────
  176.  
  177.      Import files from another PCBoard BBS to your BBS.
  178.      ┌────────────────────────────────────────────────────────────────────┐
  179.      │ 1) Call your favorite BBS.                                         │
  180.      │ 2) Turn your Communication program CAPTURE on.                     │
  181.      │ 3) Do a (Z)ippy search or search (N)ew files and the descriptions  │
  182.      │    will be captured to the capture file.                           │
  183.      │ 4) Download the files.                                             │
  184.      │ 5) Run ADDPCB.                                                     │
  185.      └────────────────────────────────────────────────────────────────────┘
  186.  
  187.  
  188.      Files placed in a hold/misc. directory for missing descriptions.
  189.      ┌────────────────────────────────────────────────────────────────────┐
  190.      │ 1) Download the ALLFILES list from a few boards.                   │
  191.      │ 2) Run ADDPCB.                                                     │
  192.      │ 3) Watch how many of the descriptions can be located.              │
  193.      │ 4) If still have files without descriptions, then get another      │
  194.      │    list and run ADDPCB again.                                      │
  195.      └────────────────────────────────────────────────────────────────────┘
  196.  
  197.  
  198.      Files on the board already but needs testing only.
  199.      ┌────────────────────────────────────────────────────────────────────┐
  200.      │ 1) Use your board's file listing.                                  │
  201.      │ 2) Change field 4 to the same as field 2.  This will then not move │
  202.      │    the files.                                                      │
  203.      │ 3) Change field 3 to the same as field 1 and go into 'Options' and │
  204.      │    set to KEEP the original description and run ADDPCB.            │
  205.      │ 4) Run ADDPCB.                                                     │
  206.      └────────────────────────────────────────────────────────────────────┘
  207.  
  208.  
  209.      Files on the board already but you would rather have the description
  210.      from FILE_ID.DIZ (if it exist).
  211.      ┌────────────────────────────────────────────────────────────────────┐
  212.      │ 1) Use your board's file listing.                                  │
  213.      │ 2) Change field 4 to the same as field 2.  This will then not move │
  214.      │    the files.                                                      │
  215.      │ 3) Change field 3 to the same as field 1 and go into 'Options' and │
  216.      │    set to OVERWRITE the original description and run ADDPCB.       │
  217.      │ 4) Run ADDPCB.                                                     │
  218.      └────────────────────────────────────────────────────────────────────┘
  219.  
  220.  
  221.      Files on the board already but you would like an easy way to convert
  222.      the description to your likeing.
  223.      ┌────────────────────────────────────────────────────────────────────┐
  224.      │ 1) Use your board's file listing.                                  │
  225.      │ 2) Change field 4 to the same as field 2.  This will then not move │
  226.      │    the files.                                                      │
  227.      │ 3) Change field 3 to the same as field 1 and go into 'Options' and │
  228.      │    set to OVERWRITE the original description and run ADDPCB.       │
  229.      │ 4) Change one or more of the Description Modification Options.     │
  230.      │ 5) Run ADDPCB.                                                     │
  231.      └────────────────────────────────────────────────────────────────────┘
  232.  
  233.  
  234.  
  235.      ADDPCB User Documentation                                       Page 4
  236.      ──────────────────────────────────────────────────────────────────────
  237.      
  238.  
  239.      INSTALLATION
  240.      ────────────
  241.  
  242.      The installation is very easy.  Put the file ADDPCB.EXE in a directory
  243.      of your choice.  Preferably your  utility directory  or a directory in
  244.      your path.  The configuration file  will be created the first time you
  245.      run the program.
  246.  
  247.  
  248.      STARTING ADDPCB
  249.      ──────────────-
  250.  
  251.      Type ADDPCB and the name of the configuration file you wish to use. If
  252.      the configuration file  does'nt exist, then one  will be created.  The
  253.      name of the configuration file/s can be any name you choose.
  254.  
  255.      Examples:
  256.  
  257.      ADDPCB ADDPCB.CFG
  258.      ADDPCB CONF0.CFG
  259.      ADDPCB CONF1.CFG
  260.      ADDPCB IMPORT.CN0
  261.      ADDPCB IMPORT.CN1
  262.  
  263.      The configuration file  is placed in the same directory  that contains
  264.      ADDPCB.EXE regardless of the directory you called the program from. If
  265.      you do not wish to have the configuration file  in the same directory,
  266.      then you must specify the full path\name  of the configuration file on
  267.      the command line or in a batch file.
  268.  
  269.      EXAMPLE:  ADDPCB C:\PCB\UTILS\ADDPCB.CFG
  270.  
  271.  
  272.  
  273.      ADDPCB User Documentation                                       Page 5
  274.      ──────────────────────────────────────────────────────────────────────
  275.  
  276.  
  277.  
  278.      COMMAND LINE OPTIONS
  279.      ────────────────────
  280.  
  281.      ADDPCB has 3 switches that can be used.  These switches  are optional.
  282.      The command format and switch parameters are described below.  A quick
  283.      review of the command switches is available by typing ADDPCB by itself.
  284.  
  285.      Automatic mode
  286.      /A or /a       Used for unattended operation.   The configuration file
  287.             you specified must exist and the fields must be correct
  288.             else the /A option will not function.
  289.             Put ADDPCB CONFIG.CFG /A in your batch file and it will
  290.             run without operator intervention.
  291.  
  292.      Registering your copy
  293.      /R or /r       Used for registering  your copy of ADDPCB.  Once it has
  294.             been registered, you will  receive a  key number.  Type
  295.             ADDPCB /R  and you will  be prompted  for your name and
  296.             number. The program will brand your copy of ADDPCB.EXE.
  297.             If you are registered and upgrading  to a later version
  298.             of ADDPCB, then you must use this switch using the same
  299.             number.
  300.  
  301.      Monochrome mode on a color monitor
  302.      /M or /m       Not that you will ever want to use this feature, but it
  303.             is there.
  304.  
  305.      Examples:
  306.  
  307.      ADDPCB IMPORT.CN0  /A
  308.      ADDPCB IMPORT.CN1  /AM
  309.      ADDPCB /R
  310.      ADDPCB ADDPCB.CFG /RM
  311.      ADDPCB CONF0.CFG
  312.      ADDPCB CONF1.CFG
  313.  
  314.  
  315.  
  316.      ADDPCB User Documentation                                       Page 6
  317.      ──────────────────────────────────────────────────────────────────────
  318.  
  319.  
  320.  
  321.      OPERATING ADDPCB
  322.      ────────────────
  323.  
  324.      The program is straight foward and should be self expanatory. Although
  325.      I'm making every attempt  to explain the program and its features.  If
  326.      you hav'nt already ran the program, now might  be a good time to do so
  327.      and get a feel for the program.  At the bottom of the screen there are
  328.      four selection items.  They are  'Exit', 'Edit Fields', 'Options', and
  329.      'Start Process'.  Before the  'Start Process'  can be selected, all of
  330.      the 'Fields' must contain valid path/names  and the files or directory
  331.      must exist (except the last one 'External Test' which is optional').
  332.      If any of the TO fields (fields 3 and 4)  does'nt exist, then you will
  333.      be be asked if you would the directory or file created for you.
  334.  
  335.  
  336.      CONFIGURATION (FIELDS)
  337.      ──────────────────────
  338.  
  339.      NOTE:
  340.      If a field is flashing, that is indicating  that the  path/name of the
  341.      file or the directory is not valid or does not exist.
  342.  
  343.  
  344.      DESCRIPTION FILE TO BE SEARCHED:                 C:\DL\ALLFILES.LST
  345.  
  346.      This is the path/name  of the description file.  It can  be a ALLFILES
  347.      list or a CAPTURE list or a DIRxx listing from your own board.
  348.  
  349.  
  350.      DIRECTORY OF FILES TO BE PROCESSED:              C:\DOWNLOAD
  351.  
  352.      This may be  the directory that is holding  your downloaded files or a
  353.      directory holding misc. files  without descriptions  or a directory of
  354.      files you want to test.
  355.  
  356.  
  357.      DESCRIPTION FILE YOU WANT TO UPDATE:             C:\PCB\MAIN\UPDIR
  358.  
  359.      This is the  path/name  of the destination file that  new descriptions
  360.      are written to.  If the path\name of the file does not exist, then you
  361.      will be asked if you want the file created for you.
  362.  
  363.  
  364.      DIRECTORY WHERE THE FILES GET MOVED TO:         C:\UPDIR
  365.  
  366.      This is the directory  that the files gets moved into.  If you  do not
  367.      wish to have the files moved, then enter the same directory as field 2
  368.      If the path\name of the directory does'nt exist then you will be asked
  369.      if you want the directory created for you.
  370.  
  371.  
  372.      EXTERNAL TEST PROGRAM:                           C:\PCB\UTIL\TEST.BAT
  373.  
  374.      Put in the path/name  of the batch file calling your test program.  If
  375.      you don't want to test the files as they are imported, then leave this
  376.      field blank.
  377.  
  378.      After the last field  has been entered, then you will be taken back to
  379.      the main choices.  Press the <left> or <right> arrow key to select and
  380.      press the <ENTER> key.
  381.  
  382.  
  383.  
  384.      ADDPCB User Documentation                                       Page 7
  385.      ──────────────────────────────────────────────────────────────────────
  386.  
  387.  
  388.  
  389.      CONFIGURATION (OPTIONS)
  390.      ───────────────────────
  391.  
  392.      CAPITALIZE THE FIRST LETTER.
  393.  
  394.      Although most descriptions will have the first letter capitalize.
  395.      There might be times  when it is not and this feature will correct it.
  396.      This feature can also be used if the description  is in all upper case
  397.      and you use the option to convert to all lower case and this option to
  398.      capitalize the first letter.
  399.  
  400.  
  401.      ALL LETERS UPPER CASE
  402.  
  403.      Convert the description imported to all upper case.
  404.  
  405.  
  406.      ALL LETTERS LOWER CASE
  407.  
  408.      Convert the description imported to all lower case.
  409.  
  410.  
  411.      UPLOADED BY:
  412.  
  413.      Choose (Y)es and you'll be prompted for your name or 'Sysop' then when
  414.      the description is imported it will contain  'Uploaded by (your name)'
  415.      on the last line of the description.
  416.  
  417.  
  418.      SET FILE DATE TO TODAY'S DATE:
  419.  
  420.      Setting this option to (Y)es will change the file date to today's date
  421.      and will change the date in the description to today's date.
  422.  
  423.  
  424.      NOTE:
  425.      These next 3 options work together  and only one of them can be set to
  426.      (Y)es at one time.
  427.  
  428.      PROMPT IF DUPLICATE IS DETECTED
  429.  
  430.      If this option is set to (Y)es  and a duplicate description  is found,
  431.      then you will be asked if you want to keep the one thats already there
  432.      or to use the new one  or to keep both.  If a duplicate file  is found
  433.      then you have the choice of keeping the one that's already there or to
  434.      overwrite with the new one.   If you have this option set to (Y)es and
  435.      are running in the unattended mode, then any duplicate descriptions or
  436.      files found will be kept  and the new file  will not be moved and will
  437.      remain where it was before.
  438.  
  439.  
  440.      DON'T PROMPT - OVERWRITE
  441.  
  442.      This option  can be used  in either the unattended  or in the attended
  443.      mode. If a duplicate description is detected, then the new description
  444.      will be appended to bottom of the description file specified in  field
  445.      3  and the description that was there before will be deleted.  The new
  446.      file will overwrite the one that was their before.
  447.  
  448.  
  449.      DON'T PROMPT - KEEP
  450.  
  451.      This option  can be used  in either the unattended  or in the attended
  452.      mode.  If a duplicate description is detected, then the  original will
  453.      stay and the new one  will not be added.  The original file  will also
  454.      stay and the new file will remain where it was before.
  455.  
  456.  
  457.  
  458.      ADDPCB User Documentation                                       Page 8
  459.      ──────────────────────────────────────────────────────────────────────
  460.  
  461.  
  462.  
  463.      EXTERNAL TESTING
  464.      ───────────────-
  465.  
  466.      If you chose to have ADDPCB test the files, then you must  specify the
  467.      name of your batch file in the field 'EXTERNAL TEST PROGRAM'.
  468.  
  469.      Your  upload tester MUST be configured  to move any failed files  to a
  470.      reject/offline/bad/hold  directory.  This will insure that ADDPCB will
  471.      detect any failed files.  If ADDPCB  sees that a file failed, then all
  472.      furture processing  of that file will end  and ADDPCB  will move on to
  473.      the next file.   The description will not be added.   If a file passed
  474.      the testing, then the description and file will be processed in.
  475.  
  476.  
  477.  
  478.      FILE_ID.DIZ SUPPORT
  479.      ──────────────────-
  480.  
  481.      ADDPCB will detect any .ZIP  archive containing the  FILE_ID.DIZ  file
  482.      and will get the description from the FILE_ID.DIZ file to import. This
  483.      feature depends on a copy of PKUNZIP.EXE being in the path.
  484.  
  485.  
  486.  
  487.      ADDPCB User Documentation                                       Page 9
  488.      ──────────────────────────────────────────────────────────────────────
  489.  
  490.  
  491.  
  492.      Support
  493.      ──────-
  494.  
  495.      Comments and suggestions about ADDPCB  are welcomed.  Please notify me
  496.      if you discover a bug, so that it can be prompty corrected.
  497.  
  498.      OnLine Exchange at (714) 870-4614.  <<< Home of ADDPCB
  499.  
  500.      I can alse be reached on: RIME      - Sysops Conf.   Bob Aune
  501.                    Ilink     - Sysops Conf.    "   "
  502.                    Metrolink - PCBHints Conf.  "   "
  503.  
  504.  
  505.  
  506.      ADDPCB User Documentation                                      Page 10
  507.      ──────────────────────────────────────────────────────────────────────
  508.  
  509.  
  510.  
  511.      Registering ADDPCB
  512.      ──────────────────
  513.  
  514.      This program is distributed as SHAREWARE.  This enables users to eval-
  515.      uate software for a 30 day  trial period.  If you  find  this  program
  516.      useful, please register it.  Otherwise, if the user finds this program
  517.      is not of sufficient merit to warrant  purchase  through  registration
  518.      then the program must be removed from their computer.
  519.  
  520.      This concept enables quality software  to be distributed  at a reason-
  521.      able cost.  I do greatly appreciate all users that care enough to reg-
  522.      ister.  I try to provide the best possible software for the supporting
  523.      users.
  524.  
  525.      You may register ADDPCB by mailing in the enclosed REGISTER.FRM  along
  526.      with a check or money order in the amount of $10.00.
  527.  
  528.      Send registration to:
  529.  
  530.      Bob Aune
  531.      2404 E. Nutwood Ave.
  532.      Fullerton, CA. 92631
  533.  
  534.      The registration charge is a one time fee that entitles you to:
  535.  
  536.      * All future versions.
  537.      * Unlimited technical support.
  538.      * Access to the OnLine Exchange BBS.
  539.      * Removal of the "Please Register" message.
  540.      * A personalized number via US Mail and on the support BBS.
  541.  
  542.      This program  may either be obtained  from normal Shareware sources or
  543.      from the OnLine Exchange BBS (714) 870-4614.
  544.  
  545.  
  546.  
  547.  
  548.      ADDPCB User Documentation                                      Page 11
  549.      ──────────────────────────────────────────────────────────────────────
  550.  
  551.  
  552.  
  553.      Legal Stuff
  554.      ───────────
  555.  
  556.      Disclaimer
  557.  
  558.      I hereby  disclaim  all warranties  relating  to this product, whether
  559.      express or implied including without limitation any implied warranties
  560.      of merchantability or fitness for a  particular purpose.  I cannot and
  561.      will not be liable for any special, incidental, consequential,indirect
  562.      or  similar damages  due to loss of data  or any  other reason.  In no
  563.      event  shall the liability for any damages ever exceed  the price paid
  564.      for the license to use software, regardless of the form  and/or extent
  565.      of the claim.  The  user  of this  program  bears  all  risk as to the
  566.      quality and performance of the software.
  567.  
  568.  
  569.  
  570.                 File Contents
  571.                 -------------
  572.  
  573.      ADDPCB.DOC   - The Document that you're reading now.
  574.      ADDPCB.EXE   - The Program.
  575.      TEST.BAT     - Sample BATCH file to call your favorite upload tester.
  576.      FILE_ID.DIZ  - Description of this program. Used by PCBoard for adding
  577.             the authors version of the description to the board
  578.             automatically.
  579.      REGISTER.FRM - Mail-in registration form.
  580.  
  581.  
  582.      This archive has been zipped  using  PKWARE  authenticity verification
  583.      system.  If there are any files in this archive that  do not  have the
  584.      verification tag  beside them (-AV), it indicates that the archive has
  585.      been tampered with  and is not  in the  original form.  If this is the
  586.      case, please call the support BBS for a valid copy.
  587.  
  588.  
  589.      Bob Aune
  590.      The OnLine Exchange
  591.      (714) 870-4614 2400-14,400 Baud V.32bis/HST
  592.